/**
 * Copyright (c) 2007-2008 Nearchos Paspallis
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

/**
 * AspectSense
 *
 * Middleware for annotation-based, context-aware and adaptive services for
 * mobile and ubiquitous computing
 *
 * This project is an open-source effort, initiated by Nearchos Paspallis as
 * part of his PhD work at the University of Cyprus (http://www.ucy.ac.cy).
 *
 * More information about the project is available at "http://aspectsense.org".
 */

package org.aspectsense.example_apps.digitalassistant;

import org.aspectsense.framework.DefaultComponent;
import com.sun.speech.freetts.VoiceManager;
import com.sun.speech.freetts.Voice;

import java.util.SortedSet;
import java.util.TreeSet;

/**
 * @author Nearchos Paspallis [nearchos@cs.ucy.ac.cy]
 *         Date: Feb 26, 2008
 *         Time: 5:37:15 PM
 */
public class AudioUI extends DefaultComponent implements UI
{
    // A sorted set containing appointments in the order of their start time
    final SortedSet<Appointment> sortedAppointments = new TreeSet<Appointment>();

    // ----------------- Handling life-cycle operations --------------------- //

    // FreeTTS 16k Voice
    private Voice voice16k;
    private String voice16kName = "kevin16";

    public void init()
    {
        super.init();

        final VoiceManager voiceManager = VoiceManager.getInstance();
        voice16k = voiceManager.getVoice(voice16kName);
        voice16k.allocate();
    }

    public void finit()
    {
        voice16k.deallocate();

        super.finit();
    }

    // -------------- End of Handling life-cycle operations ----------------- //

    // ------------------ Implementing the UI interface --------------------- //

    public void addedAppointment(final Appointment addedAppointment)
    {
        sortedAppointments.add(addedAppointment);

//        communicateText("Added appointment: " + addedAppointment.toSpeakableText());
    }

    public void cancelledAppointment(final Appointment cancelledAppointment)
    {
        sortedAppointments.remove(cancelledAppointment);

        communicateText("Cancelled appointment: " + cancelledAppointment.toSpeakableText());
    }

    public void modifiedAppointment(final Appointment previousAppointment, final Appointment newAppointment)
    {
        sortedAppointments.remove(previousAppointment);
        sortedAppointments.add(newAppointment);

        communicateText("Modified previous appointment titled " + previousAppointment.getName());
        communicateText("The new appointment is: " + newAppointment.toSpeakableText());
    }

    public void communicateCompleteAgenda()
    {
        final int numOfAppointments = sortedAppointments.size();
        String message;
        if(numOfAppointments == 0)
        {
            message = "There are no appointments scheduled";
        }
        else if(numOfAppointments == 1)
        {
            message = "There is one appointment scheduled: " + sortedAppointments.iterator().next().toSpeakableText();
        }
        else
        {
            message = "There are " + numOfAppointments + " appointments scheduled. ";
            message += "The next one is: " + sortedAppointments.iterator().next().toSpeakableText();
        }

        communicateText(message);
    }

    private void communicateText(final String message)
    {
        voice16k.speak(message);
    }

    // --------------- End of Implementing the UI interface ----------------- //
}